/**
 * Copyright (c) 2008, Mu Dynamics.
 *  All rights reserved.
 *  
 *   Redistribution and use in source and binary forms, with or without modification, 
 *   are permitted provided that the following conditions are met:
 *   
 *  - Redistributions of source code must retain the above copyright notice, 
 *     this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice, 
 *     this list of conditions and the following disclaimer in the documentation and/or 
 *     other materials provided with the distribution.
 *  - Neither the name of the "Mu Dynamics" nor the names of its contributors may be used 
 *     to endorse  or promote products derived from this software without specific prior 
 *     written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.mu.jacob.core.model;

import java.util.Set;

import javax.lang.model.element.Element;
import javax.lang.model.element.PackageElement;
import javax.lang.model.element.TypeElement;
import javax.lang.model.util.Elements;
import javax.lang.model.util.Types;

import com.google.inject.ImplementedBy;

/**
 * Internal model interface used by Jacob
 * @author Adam Smyczek
 */
@ImplementedBy(Model.class)
public interface IModel {

	/**
	 * @return model classes
	 */
	public Set<TypeElement> getClasses();
	
	/**
	 * @return model interfaces
	 */
	public Set<TypeElement> getInterfaces();
	
	/**
	 * @return model packages
	 */
	public Set<PackageElement> getPackages();
	
	/**
	 * @return all root elements as provided by RoundEnvironment
	 */
	public Set<? extends Element> getRootElements();
	
	/**
	 * @param a
	 * @return All elements annotated with annotation a
	 */
	public Set<? extends Element> getElementsAnnotatedWith(TypeElement a);
	
	/**
	 * @return Elements utils
	 */
	public Elements getElements();
	
	/**
	 * @return Types utils
	 */
	public Types getTypes();
	
	/**
	 * Evaluates if an object is part of the model object list
	 * @param object
	 * @return true if the object is part of the model
	 */
	public boolean isModelObject(Object object);
	
	/**
	 * Checks if passed element or type represents java.lang.Object
	 * @param object
	 * @return true if element or type is java.lang.Object
	 */
	public boolean isObject(Object object);
		
}
